Retrieve Payment Execution Status (v1)

Retrieve Payment Execution Status

Query GET tag:PaymentsInternal

Overview

Retrieve payment execution status.

GET (/internal/v1/parties/{partyId}/payments/{paymentId}/status)

Parameters

  • partyId (path) (required): The ID of the party that owns the accounts. See PartyId Model.

  • paymentId (path) (required): The ID of the payment. See PaymentIdParameter model.

  • plmr-user-action (header): Header used to indicate whether the request is user initiated request. When set to true, the user session gets extended with the default session timeout. When set to false, or header is not present the user session is not extended. See plmrUserAction model.

Responses

200 OK

Body of the response for payment execution status.

404 Not Found

500 Internal Server Error

Architecture

8 properties

Body of the response for payment execution status.

paymentStatus string

The payment status is filled with codes of the ISO 20022 data table: - 'ACCC': 'AcceptedSettlementCompleted' - Settlement on the creditor's account has been completed. - 'RCVD': 'Received' - Payment initiation has been received by the receiving agent. - 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.

Allowed values: ACCC RCVD RJCT
statusDateTime string <date-time>
rejectionReason object
paymentStatusHistory array [object]
7 properties
code string
Allowed values: urn:plmr:payments:api:COUNTERPARTY_INVALID_NAME urn:plmr:payments:api:COUNTERPARTY_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_ACCOUNT_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_PAYMENT_METHOD_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_DETAILS_PROPERTIES_NOT_FOUND urn:plmr:payments:api:COUNTERPARTY_NOT_FOUND urn:plmr:payments:api:PAYMENT_METHOD_NOT_FOUND urn:plmr:payments:api:MISSING_PAYMENT_METHOD_ID urn:plmr:payments:api:INVALID_INIT_PAYMENT_WITH_COUNTERPARTY urn:plmr:payments:api:INVALID_STANDING_ORDER_WITH_COUNTERPARTY urn:plmr:payments:api:INTERNAL_SERVER_ERROR urn:plmr:payments:api:BAD_REQUEST urn:plmr:payments:api:RESOURCE_UNKNOWN urn:plmr:payments:api:UNAUTHORIZED urn:plmr:payments:api:FORBIDDEN urn:plmr:payments:api:INVALID_PARAM urn:plmr:payments:api:WEB_APPLICATION urn:plmr:payments:api:PAYMENT_NOT_FOUND urn:plmr:payments:api:INVALID_IBAN_BANK_IDENTIFIER urn:plmr:payments:api:INVALID_DEBTOR_IBAN urn:plmr:payments:api:INVALID_CREDITOR_IBAN urn:plmr:payments:api:INVALID_AMOUNT_CURRENCY urn:plmr:payments:api:INVALID_DEBTOR_ACCOUNT_CURRENCY urn:plmr:payments:api:INVALID_CREDITOR_ACCOUNT_CURRENCY urn:plmr:payments:api:START_DATE_IN_THE_PAST urn:plmr:payments:api:STANDING_ORDER_ALREADY_STARTED urn:plmr:payments:api:INVALID_ONE_TIME_SCHEDULE urn:plmr:payments:api:INVALID_RECURRENT_SCHEDULE urn:plmr:payments:api:STANDING_ORDER_NOT_FOUND urn:plmr:payments:api:STANDING_ORDER_EXECUTING urn:plmr:payments:api:NO_SCHEDULED_EXECUTIONS urn:plmr:payments:api:IDENTICAL_QUOTE_CURRENCIES urn:plmr:payments:api:NULL_CURRENCY_EXCHANGE_DETAILS urn:plmr:payments:api:AMOUNT_IS_TOO_SMALL urn:plmr:payments:api:CURRENCY_EXCHANGE_TIME_WINDOW_CLOSED urn:plmr:payments:api:INVALID_INSTRUCTED_AMOUNT_CURRENCY urn:plmr:payments:api:DEVICE_INTEGRITY_TOKEN_NOT_FOUND
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:payments:api:COUNTERPARTY_INVALID_NAME urn:plmr:payments:api:COUNTERPARTY_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_ACCOUNT_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_PAYMENT_METHOD_ALREADY_EXIST urn:plmr:payments:api:COUNTERPARTY_DETAILS_PROPERTIES_NOT_FOUND urn:plmr:payments:api:COUNTERPARTY_NOT_FOUND urn:plmr:payments:api:PAYMENT_METHOD_NOT_FOUND urn:plmr:payments:api:MISSING_PAYMENT_METHOD_ID urn:plmr:payments:api:INVALID_INIT_PAYMENT_WITH_COUNTERPARTY urn:plmr:payments:api:INVALID_STANDING_ORDER_WITH_COUNTERPARTY urn:plmr:payments:api:INTERNAL_SERVER_ERROR urn:plmr:payments:api:BAD_REQUEST urn:plmr:payments:api:RESOURCE_UNKNOWN urn:plmr:payments:api:UNAUTHORIZED urn:plmr:payments:api:FORBIDDEN urn:plmr:payments:api:INVALID_PARAM urn:plmr:payments:api:WEB_APPLICATION urn:plmr:payments:api:PAYMENT_NOT_FOUND urn:plmr:payments:api:INVALID_IBAN_BANK_IDENTIFIER urn:plmr:payments:api:INVALID_DEBTOR_IBAN urn:plmr:payments:api:INVALID_CREDITOR_IBAN urn:plmr:payments:api:INVALID_AMOUNT_CURRENCY urn:plmr:payments:api:INVALID_DEBTOR_ACCOUNT_CURRENCY urn:plmr:payments:api:INVALID_CREDITOR_ACCOUNT_CURRENCY urn:plmr:payments:api:START_DATE_IN_THE_PAST urn:plmr:payments:api:STANDING_ORDER_ALREADY_STARTED urn:plmr:payments:api:INVALID_ONE_TIME_SCHEDULE urn:plmr:payments:api:INVALID_RECURRENT_SCHEDULE urn:plmr:payments:api:STANDING_ORDER_NOT_FOUND urn:plmr:payments:api:STANDING_ORDER_EXECUTING urn:plmr:payments:api:NO_SCHEDULED_EXECUTIONS urn:plmr:payments:api:IDENTICAL_QUOTE_CURRENCIES urn:plmr:payments:api:NULL_CURRENCY_EXCHANGE_DETAILS urn:plmr:payments:api:AMOUNT_IS_TOO_SMALL urn:plmr:payments:api:CURRENCY_EXCHANGE_TIME_WINDOW_CLOSED urn:plmr:payments:api:INVALID_INSTRUCTED_AMOUNT_CURRENCY urn:plmr:payments:api:DEVICE_INTEGRITY_TOKEN_NOT_FOUND
message string
requestId string
fieldErrors array [object]